Overview
The GetOrganizations operation retrieves the universe of organizations based on the user credentials included in the request.
This operation returns a collection of pair data for the username provided. The list of organizations returned is based on the user’s role:
- Standard User (does not have ‘System Administrator’ application role): returns the organizations the user is assigned to and all organizations up the hierarchy tree structure.
- System Administration User (has ‘System Administrator’ application role): returns the organizations the user is assigned and all organizations up and down the hierarchy tree structure.
| Operation |
ListDocuments |
|---|
| Style |
document |
| Operation |
Request-response |
| SOAP Action |
http://tempuri.org/IIntegrationService/GetOrganizations |
| Input |
IIntegrationService_GetOrganizations_InputMessage (soap:body, use = literal) parameters type GetOrganizationsRequest |
| Output |
IIntegrationService_GetOrganizations_OutputMessage (soap:body, use = literal) parameters type GetOrganizationsResponse |
Request Message
The operation input is GetOrganizationsRequest. The request requires a GetOrganizationsRequest object containing user and password as parameters on the input.
| Parameter |
Type |
Constraints |
Description |
|---|
| request |
GetOrganizations |
Required |
The input message for the GetOrganizations operation used to request a list of OPPSA organizations. |
Response Element
The operation output is GetOrganizationsResponse. The response returns a GetOrganizationsRequest object containing status information for the request.
| Element |
Type |
Description |
|---|
| GetOrganizationsResponse |
GetOrganizationsResponse |
The output message for the GetOrganizations operation used to return the details of the request. |
GetOrganizations Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:int="http://integrationservice.oppsa.wk">
<soapenv:Header/>
<soapenv:Body>
<tem:GetOrganizations>
<!--Optional:-->
<tem:userName>user1</tem:userName>
<!--Optional:-->
<tem:password>Password111!</tem:password>
</tem:GetOrganizations>
</soapenv:Body>
</soapenv:Envelope>
GetOrganizations Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="cd3542ea-e7f0-4c61-a315-96bda86074a6" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">40771ae9-8191-41fa-b648-83257032aabf</ActivityId>
</s:Header>
<s:Body>
<GetOrganizationsResponse xmlns="http://integrationservice.oppsa.wk">
<GetOrganizationsResult xmlns:a="http://schemas.datacontract.org/2004/07/WoltersKluwerFS.OPPSA.Web.DataContracts">
<a:OrganizationInfo>
<a:OrganizationGUID>d22a1b1c7d111d666709a71a18d6a7d2</a:OrganizationGUID>
<a:OrganizationShortName>Root Org</a:OrganizationShortName>
</a:OrganizationInfo>
<a:OrganizationInfo>
<a:OrganizationGUID>555a1b2c03da46189456e05f44ge111c</a:OrganizationGUID>
<a:OrganizationShortName>Main Bank</a:OrganizationShortName>
</a:OrganizationInfo>
</GetOrganizationsResult>
</GetOrganizationsResponse>
</s:Body>
</s:Envelope>
